ChangeLinkStatus

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODFrame

ChangeLinkStatus
The ChangeLinkStatus method changes the link status of this frame.
void ChangeLinkStatus (in ODLinkStatus status);
status
The link status to assign to this frame. The value of status must be one of the following: kODInLinkDestination, kODInLinkSource, or kODNotInLink.

DISCUSSION
The value kODInLinkDestination for the status parameter indicates that the frame is embedded in the destination of a link; the content of this frame is thus supplied by a link. The value kODInLinkSource indicates that the frame is embedded in content that is the source of one or more links, but not in content that is the destination of a link. The value kODNotInLink indicates that the frame is not embedded in any linked content, source or destination.
If your part supports linking or embedding, your part calls this method for each embedded frame that is involved in a link when a link is created, broken, or moved. If your part supports linking only, your part calls this method for each frame not in a link. This method in turn calls the LinkStatusChanged method associated with this frame's part to notify the part that its link status has changed. In turn, the embedded part's LinkStatusChanged method gives that embedded part a chance to call the ChangeLinkStatus method for other embedded frames.

EXCEPTIONS

kODErrInvalidLinkStatus
The specified link status is invalid.

SEE ALSO
The ODLinkStatus type (page 882).
The ODFrame::GetLinkStatus method (page 321).
The ODPart::LinkStatusChanged method (page 532).
"When to Change Link Status" on page 374 in OpenDoc Programmer's Guide.
"Creating a Link at the Destination" on page 380 in OpenDoc Programmer's Guide.